/*
 * Copyright (C) 2009 Leandro Aparecido <lehphyro@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.metalframework.persistence.repository.ret;

import org.metalframework.persistence.annotation.*;
import org.metalframework.persistence.repository.query.*;

/**
 * Parameters to execute queries against the repository when returning
 * the value of a method invocation.
 * <p>Usually, defined using annotations.
 * 
 * @since 1.0
 * @see org.metalframework.persistence.annotation.RepositoryReturn
 * @see org.metalframework.persistence.repository.RepositoryAnnotationParameters
 */
public class RepositoryReturnParameters extends RepositoryQueryParameters {
	/**
	 * Class of the exception to throw when the result of the query
	 * is empty or null.
	 */
	private Class<? extends Throwable> empty;
	
	/**
	 * indicates if should throw exception when the result of the query
	 * is empty or null.
	 * 
	 * @return True if should throw exception.
	 */
	public boolean shouldThrowException() {
		return !IgnoreEmptyResultException.class.isAssignableFrom(empty);
	}
	
	public Class<? extends Throwable> getEmpty() {
		return empty;
	}
	
	public void setEmpty(Class<? extends Throwable> empty) {
		this.empty = empty;
	}
}
